/**
 * Software License, Version 1.0
 * 
 * Copyright 2003 The Trustees of Indiana University.  All rights reserved.
 * 
 *
 *Redistribution and use in source and binary forms, with or without 
 *modification, are permitted provided that the following conditions are met:
 *
 *1) All redistributions of source code must retain the above copyright notice,
 * the list of authors in the original source code, this list of conditions and
 * the disclaimer listed in this license;
 *2) All redistributions in binary form must reproduce the above copyright 
 * notice, this list of conditions and the disclaimer listed in this license in
 * the documentation and/or other materials provided with the distribution;
 *3) Any documentation included with all redistributions must include the 
 * following acknowledgement:
 *
 *"This product includes software developed by the Community Grids Lab. For 
 * further information contact the Community Grids Lab at 
 * http://communitygrids.iu.edu/."
 *
 * Alternatively, this acknowledgement may appear in the software itself, and 
 * wherever such third-party acknowledgments normally appear.
 * 
 *4) The name Indiana University or Community Grids Lab or NaradaBrokering, 
 * shall not be used to endorse or promote products derived from this software 
 * without prior written permission from Indiana University.  For written 
 * permission, please contact the Advanced Research and Technology Institute 
 * ("ARTI") at 351 West 10th Street, Indianapolis, Indiana 46202.
 *5) Products derived from this software may not be called NaradaBrokering, 
 * nor may Indiana University or Community Grids Lab or NaradaBrokering appear
 * in their name, without prior written permission of ARTI.
 * 
 *
 * Indiana University provides no reassurances that the source code provided 
 * does not infringe the patent or any other intellectual property rights of 
 * any other entity.  Indiana University disclaims any liability to any 
 * recipient for claims brought by any other entity based on infringement of 
 * intellectual property rights or otherwise.  
 *
 *LICENSEE UNDERSTANDS THAT SOFTWARE IS PROVIDED "AS IS" FOR WHICH NO 
 *WARRANTIES AS TO CAPABILITIES OR ACCURACY ARE MADE. INDIANA UNIVERSITY GIVES
 *NO WARRANTIES AND MAKES NO REPRESENTATION THAT SOFTWARE IS FREE OF 
 *INFRINGEMENT OF THIRD PARTY PATENT, COPYRIGHT, OR OTHER PROPRIETARY RIGHTS. 
 *INDIANA UNIVERSITY MAKES NO WARRANTIES THAT SOFTWARE IS FREE FROM "BUGS", 
 *"VIRUSES", "TROJAN HORSES", "TRAP DOORS", "WORMS", OR OTHER HARMFUL CODE.  
 *LICENSEE ASSUMES THE ENTIRE RISK AS TO THE PERFORMANCE OF SOFTWARE AND/OR 
 *ASSOCIATED MATERIALS, AND TO THE PERFORMANCE AND VALIDITY OF INFORMATION 
 *GENERATED USING SOFTWARE.
 */
package cgl.narada.service.reliable.impl;

import cgl.narada.event.EventHeaders;
import cgl.narada.event.NBEvent;
import cgl.narada.event.impl.NBEventGenerator;
import cgl.narada.service.ServiceException;
import cgl.narada.service.fragmentation.FragmentationService;
import cgl.narada.service.qos.impl.QosServiceImpl;

public class RdFragmentationHelper implements RdDebugFlags {
  private QosServiceImpl qosServiceImpl;
  private FragmentationService fragmentationService;
  private NBEventGenerator nbEventGenerator;

  private String moduleName = "RdFragmentationHelper: ";

  public RdFragmentationHelper(QosServiceImpl qosServiceImpl) {
    this.qosServiceImpl = qosServiceImpl;
    fragmentationService = qosServiceImpl.getFragmentationService();
    nbEventGenerator = qosServiceImpl.getEventGenerator();
  }
  
  /** After recovery, we need to make sure that any pending fragments of files
      need to be sent across */
  public void onRecovery(int publisherCatenationNum) throws ServiceException{
    fragmentationService.checkForPendingTransfers(publisherCatenationNum);
  }
  
  /* The draining needs to be done to ensure that while we are sending
     extremely large payloads, the memory utilization does not cause
     an OutOfMemory Error */
  public void drainPayloadFromEvent(NBEvent fragmentedEvent) {
    byte[] drainerPayload = new byte[1];
    drainerPayload[0] = 1;
    nbEventGenerator.setPayload(fragmentedEvent, drainerPayload);
    if (RdFragmentationHelper_Debug) {
      long totalMemory = 
	Runtime.getRuntime().totalMemory();
      System.out.println("\n\n" + moduleName + "Total Memory Utilization = " +
			 totalMemory + "\n\n");
    }
  }
  
  
  /** If there is a retransmission request and the event is a fragmented one,
      we need to retrieve this informtion from a file and then add this to
      the payload */
  public void refillPayloadIntoEvent(NBEvent fragmentedEvent) 
    throws ServiceException {
    if (!fragmentedEvent.hasEventHeaders()) {
      throw new ServiceException(moduleName + "Trying to refillPayload into " +
				 " an event that has no headers. ");
    }
    EventHeaders headers = fragmentedEvent.getEventHeaders();
    int fragmentNumber = headers.getFragmentNumber();
    String filename = headers.getFragmentationIdentifier();
    
    byte[] retrievedPayload = 
      fragmentationService.retrievePayloadForFragment(filename,fragmentNumber);
    
    nbEventGenerator.setPayload(fragmentedEvent, retrievedPayload);
  }
  
  
  /** Keeps track of the catenation number that has been assigned to
      individual fragments */
  public void 
  catenationNumberAssigned(NBEvent fragmentedEvent, int catenationNumber) 
    throws ServiceException {
    
    if (!fragmentedEvent.hasEventHeaders()) {
      throw new ServiceException(moduleName + "Trying to refillPayload into " +
				 " an event that has no headers. ");
    }
    EventHeaders headers = fragmentedEvent.getEventHeaders();
    int fragmentNumber = headers.getFragmentNumber();
    String filename = headers.getFragmentationIdentifier();
    
    fragmentationService.assignedCatenationNum(filename, fragmentNumber, 
					       catenationNumber);
  }
  
  
  public void
  fragmentStoredReliably(NBEvent fragmentedEvent)  
    throws ServiceException  {
    
    if (!fragmentedEvent.hasEventHeaders()) {
      throw new ServiceException(moduleName + "Trying to refillPayload into " +
				 " an event that has no headers. ");
    }
    EventHeaders headers = fragmentedEvent.getEventHeaders();
    int fragmentNumber = headers.getFragmentNumber();
    String filename = headers.getFragmentationIdentifier();
    
    fragmentationService.processReliableStorageOf(filename, fragmentNumber);
    
  }
  
}
